home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / rabir200.zip / RABIRTH.DOC < prev    next >
Text File  |  1993-01-15  |  11KB  |  427 lines
  1.  
  2.   ╔════════════════════════════════════════════════════════════════════════╗
  3.   ║░░░░░ RABIRTH ░░░░░ For RemoteAccess 1.11 ░░░░░░░░░░ Documentation ░░░░░║
  4.   ╚════════════════════════════════════════════════════════════════════════╝
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                                 RABIRTH 2.00
  26.  
  27.                   A birthday utility for RemoteAccess 1.xx
  28.  
  29.  
  30.                      (c) 1991, 1992, 1993 Hamish Moffatt
  31.  
  32.  
  33.  
  34.                               Fidonet 3:635/552
  35.  
  36.  
  37.  
  38.                                 Documentation
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.   ╔════════════════════════════════════════════════════════════════════════╗
  64.   ║░░░░░ RABIRTH ░░░░░ For RemoteAccess 1.11 ░░░░░░░░░░ Documentation ░░░░░║
  65.   ╚════════════════════════════════════════════════════════════════════════╝
  66.  
  67.  
  68.    Introduction
  69.    ════════════
  70.  
  71.    RABIRTH is a  utility for  RemoteAccess  1.00 and later  (including 1.11). 
  72.    RABIRTH does  a  number of things  with a user's  birthdate field in  the 
  73.    user record, and other birthdate sources.
  74.  
  75.  
  76.    Features of RABIRTH
  77.    ═══════════════════
  78.  
  79.         ■ ANS/ASC/AVT List of all users and their birthdays.
  80.         ■ ANS/ASC/AVT List of all users having birthdays this month.
  81.         ■ ANS/ASC/AVT List of users with birthdays today/tomorrow/yesterday.
  82.  
  83.  
  84.         ■ Post messages to  users on  their birthdays  using a template file 
  85.           with $macros.
  86.         ■ Message base locking for multinode systems.
  87.         ■ Send  users  their  birthday  messages  through  netmail  or  even
  88.           through your local Internet/UUCP gateway.
  89.         ■ Define people (such as your friends) to  send birthday messages to 
  90.           through netmail/UUCP who aren't even users of your BBS!
  91.  
  92.  
  93.         ■ Full handle support, on messages and bulletin screens.
  94.         ■ Log for sysop of birthdays today, messages posted, errors.
  95.         ■ Opus or FrontDoor log.
  96.         ■ Support for hidden users.
  97.  
  98.  
  99.         ■ Configuration  of  most  parameters,  including  all text  strings
  100.           and colours.  English, Italian and  German language configurations
  101.           are included in the package.
  102.  
  103.  
  104.    RABIRTH 2.00 has been tested with RemoteAccess 1.11.
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.         RABIRTH 2.00 Documentation                              Page 1
  121.  
  122.  
  123.  
  124.    Configuration of RABIRTH
  125.    ════════════════════════
  126.  
  127.    RABIRTH is configured by a standard text  file (called RABIRTH.CFG) which 
  128.    you must create with  your favourite  text editor  (a sample is supplied). 
  129.    RABIRTH.CFG uses keywords like  most  other  configuration  files.
  130.  
  131.    RABIRTH 2.00's  configuration is  vastly different  from that of  RABIRTH
  132.    1.xx,  so you  must set  it up  from scratch.  This should be  reasonably 
  133.    painless though.
  134.  
  135.    Specifics of the configuration are found in RABIRTH.CFG.
  136.  
  137.  
  138.    Language Configuration
  139.    ══════════════════════
  140.  
  141.    RABIRTH also allows you to  configure all its text  strings.  The default 
  142.    language file is RABIRTH.LNG.  (You can override this with a command line 
  143.    parameter).  If you wish  to change any strings or translate,  please see 
  144.    your RABIRTH.LNG. It contains all you need to know to change anything. 
  145.  
  146.  
  147.    Examples are supplied in several languages:
  148.  
  149.               ENGLISH.LNG -  English. 
  150.               GERMAN.LNG  -  German.  
  151.               ITALIAN.LNG -  Italian.
  152.  
  153.    The included RABIRTH.LNG (the default language filename) is a copy of the 
  154.    English language file. If you create a language file for another language,
  155.    please send it to me  (at the addresses below)  for inclusion in a future
  156.    release of RABIRTH.
  157.  
  158.  
  159.    Message Template Macros
  160.    ═══════════════════════
  161.  
  162.    The message template file is named RABIRTH.TXT. The message text found in 
  163.    RABIRTH.TXT will be sent to users on their birthdays.
  164.  
  165.    RABIRTH supports several $macros (or metastrings) in the message template
  166.    file. These are as follows. 
  167.  
  168.  
  169.         Macro           Translates to           Eg
  170.         ══════════════════════════════════════════════════════════
  171.         $name           user's full name        Hamish Moffatt
  172.         $first          user's first name       Hamish
  173.         $last           user's other names      Moffatt
  174.         $handle         user's handle if set    Hamster
  175.         $dayname        name of day of week     Friday
  176.         $monthname      name of month           October
  177.         $day            day of month            11
  178.         $dayth          day with suffix         11th
  179.  
  180.  
  181.         RABIRTH 2.00 Documentation                              Page 2
  182.  
  183.  
  184.  
  185.         Macro           Translates to           Eg
  186.         ══════════════════════════════════════════════════════════
  187.         $month          month of year           10
  188.         $year           year                    1991
  189.         $birthyear      year of user's birth    1976
  190.         $age            age of user             14
  191.       * $ageth          age with suffix         14th
  192.  
  193.  
  194.    * Important note:  while $dayth will return  the correct day  number  and
  195.      suffix from  the language  configuration,  $ageth is NOT  change-able - 
  196.      the suffix is always in English! If you use a foreign language,   avoid 
  197.      use of $ageth. 
  198.  
  199.  
  200.    Example:
  201.  
  202.  
  203.    Hello $handle!
  204.  
  205.    It has come to our attention that today, $dayname, $monthname $day, $year, 
  206.    you have turned $age!
  207.  
  208.    Happy Birthday from the users of Cloud Nine!
  209.  
  210.    Regards,
  211.    Hamish Moffatt
  212.  
  213.   
  214.    When sent to a user, this would appear something like:
  215.  
  216.  
  217.    Hello Hamster!
  218.  
  219.    It has come to our attention that today, Friday, October 11, 1991,
  220.    you have turned 24!
  221.  
  222.    Happy Birthday from the users of Cloud Nine!
  223.  
  224.    Regards,
  225.    Hamish Moffatt
  226.  
  227.  
  228.    Running RABIRTH
  229.    ═══════════════
  230.  
  231.    RABIRTH  requires   no  command  line  parameters,   but  there  are  two
  232.    you can  use;  see below.  When  RABIRTH is run  (by typing  RABIRTH,  or 
  233.    from a batch file), it will display something like the following.
  234.  
  235.    ■ RABirth 2.00 for RemoteAccess 1.11
  236.    ■ Written by Hamish Moffatt of 3:635/552@fidonet
  237.  
  238.    ■ Reading configuration file (RABIRTH.CFG)
  239.    ■ Reading language configuration (RABIRTH.LNG)
  240.    ■ Working...
  241.  
  242.         RABIRTH 2.00 Documentation                              Page 3
  243.  
  244.  
  245.  
  246.    ■ 0 user(s) have birthdays today
  247.    ■ 1 user(s) have birthdays tomorrow
  248.    ■ 2 user(s) had  birthdays yesterday
  249.  
  250.    ■ Thanks for registering!
  251.    ■ Done
  252.  
  253.  
  254.    The following command line switches can alter the behavior of RABIRTH.
  255.  
  256.                    -C<filename>     Use the file specified as the configurat-
  257.                                     ion file, rather than RABIRTH.CFG.  This
  258.                                     may be  useful in multiline or  multiple
  259.                                     language systems.
  260.  
  261.                 -L<filename>        Use the file  specified as the  language 
  262.                                     file rather than RABIRTH.LNG. Again this
  263.                                     may be  useful if  you want  to  attempt 
  264.                                     multiple languages.
  265.  
  266.  
  267.    Legal section (do not stop reading here!)
  268.    ═════════════
  269.  
  270.    RABIRTH is not freeware or public domain;  RABIRTH is shareware.  After a 
  271.    reasonable trial period (14 days suggested), you are expected to register
  272.    your copy of RABIRTH with the author.  See the "Registration" section for
  273.    details.
  274.  
  275.  
  276.    RABIRTH is  (c)opyright 1991, 1992, 1993 Hamish Moffatt.  Disassembly  of
  277.    and modifications to the executables and documentation is NOT allowed.
  278.  
  279.    Use in a commercial environment without  registration is prohibited after
  280.    the trial period!
  281.  
  282.  
  283.    Registration of RABIRTH
  284.    ═══════════════════════════════════
  285.  
  286.     Registration type                  ║ Price (Australian dollars)
  287.     ═══════════════════════════════════╬═══════════════════════════
  288.     Non-commercial environment         ║ $10.00
  289.     Commercial environment             ║ $20.00, or contact the author
  290.     ═══════════════════════════════════╩═══════════════════════════
  291.  
  292.    Please print  out and complete  the  registration form  found in the file
  293.    REGISTER.DOC, and post to the address found in "Contacting the author".
  294.  
  295.    Personal cheques are  not acceptable.  Bank drafts, money orders and cash
  296.    are acceptable. If you cannot send any of these, picture postcards are an
  297.    acceptable alternative.
  298.  
  299.  
  300.  
  301.  
  302.  
  303.         RABIRTH 2.00 Documentation                              Page 4
  304.  
  305.  
  306.  
  307.  
  308.    When unregistered, messages posted to users by RABIRTH have this tearline
  309.    on the end (eg):
  310.  
  311.  
  312.    --- RABIRTH 2.00 Unregistered
  313.  
  314.  
  315.    When registered,  RABIRTH will not insert this line,  but instead a ^aPID 
  316.    line (eg: ^aPID: RABIRTH 2). Your users will not know the message is from
  317.    a robot once registered!
  318.  
  319.  
  320.    Feedback, bug reports, suggestions
  321.    ══════════════════════════════════
  322.  
  323.    Feedback,  bug reports and  suggestions are  most  welcome,  particularly 
  324.    suggestions. Please post to any of the addresses in the following section.
  325.  
  326.  
  327.    Contacting the author
  328.    ═════════════════════
  329.  
  330.    The author of RABIRTH is Hamish Moffatt.
  331.  
  332.    You can reach me at:
  333.  
  334.       3:635/552@fidonet,       58:4100/43@intlnet,    199:4242/10@rainbownet, 
  335.       61:9420/1310@worldnet,   15:4100/113@sbcnet.
  336.  
  337.       Internet:    hamish@cloud.apana.org.au
  338.       CompuServe:  >INTERNET:hamish@cloud.apana.org.au
  339.  
  340.  
  341.       Postal:      Hamish Moffatt
  342.                    10 Ryrie Place
  343.                    Vermont South,
  344.                    Melbourne, VIC,
  345.                    Australia. 3133.
  346.  
  347.  
  348.  
  349.    Credits and Thank yous
  350.    ══════════════════════
  351.  
  352.    Thank you to...
  353.  
  354.  
  355.         ■ RemoteAccess          Andrew Milner and Continental Software
  356.         ■ Turbo Pascal 6.0      Borland International
  357.  
  358.         ■ The RABIRTH 2.00 beta team:
  359.  
  360.                 Harry Konstantinou, David Leach, Andrew Pam.
  361.                    (and any others I've forgotten..)
  362.  
  363.  
  364.         RABIRTH 2.00 Documentation                              Page 5
  365.  
  366.  
  367.  
  368.         ■ Translators:
  369.  
  370.                 Matt Laeng         3:632/358.989 for German translation.
  371.                 Fabiano Fabris     2:285/304.100 for Italian translation.
  372.  
  373.  
  374.           Thank you also to Bob R. and others for all their wonderful sugges-
  375.           ions, and to the (very) few registered users.
  376.  
  377.  
  378.  
  379.    The end
  380.    ═══════
  381.         
  382.    You're still here?  Well you can go configure RABIRTH now,  then fill out
  383.    the registration form and post it to me with your cheque. <grin>
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.         RABIRTH 2.00 Documentation                              Page 6
  426.  
  427.